CIMPLICITY Configuration REST API Web Service
CIMPLICITY Configuration REST API Web Service / All Operations Resource Group / /projects/{projectId}/users:read (Post)
Post/projects/{projectId}/users:read
Description
Gets an array of users objects that satisfy the filter criteria specified in the request body.
Parameters
NameDescriptionData Type
the id of the projectstring
Request (application/json)

The request body is of type object.

Overview

Filters : UserFilters
UserID : string
RoleID : string
limit : integer
skip : integer
200 Response

The response body is of type UsersGetResponse.

The collection of users that satisfy the query.

Overview

UsersGetResponse
The results of the users get query.
Users : Array[CimUser]
AuthenticationType : CimUserType
Enable : boolean
PasswordExpiresInDays : number
Password : string
Resources : Array[string]
RoleID : string
UserID : string
UserName : string
Fault Responses
FaultDescription
This fault returns a response body of type ProblemDetails.
project with the given id is not registered on the system
Remarks
Returns JSON containing an array of CIMPLICITY user objects
See Also